schm-inbound-sap-eapi

(0 reviews)

API Reference (Chinese Version)

schm-inbound-sap-eapi

接口描述: 单据上传接口
DEV地址（开发环境）: https://schm-api-dev.shiseido.cn/schm-inbound-sap-eapi/api/v1
UAT地址（测试环境）: https://schm-api-test.shiseido.cn/schm-inbound-sap-eapi/api/v1
PROD地址（生产环境）: https://schm-api.shiseido.cn/schm-inbound-sap-eapi/api/v1

1.身份认证

所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。

client_id: fa98****3452
client_secret: 108b****41f2

注意:

生产环境和测试环境的认证方式不同，在生产环境中，需要使用之前注册的账号，登录后，点击对应的应用上线，就会出现生产使用的client_id和client_secret。

2.检查连通性:

可以通过curl命令或者接口工具调用/healthCheck检查接口连通性，成功则返回ok，检查地址如下：

DEV地址（开发环境）: https://schm-api-dev.shiseido.cn/schm-inbound-sap-eapi/healthCheck
UAT地址（测试环境）: https://schm-api-test.shiseido.cn/schm-inbound-sap-eapi/healthCheck
PROD地址（生产环境）: https://schm-api.shiseido.cn/schm-inbound-sap-eapi/healthCheck

3.接口总览:

请求接口	描述
/inbound/oms	ToC 销售单明细上传
/inbound/pos	ToB 业务单据上传
/inbound/purchase	ToB 采购单据上传
/inbound/inprogress	ToC 进行中销售单上传（对账用）
/inbound/revise	ToC 金额调整单上传（对账用）
/inbound/coupoChargePlatform	POS传送对账平台的借贷支付方式
/businessSubtbl/update	POS回传直营店到货状态

完整调用地址为对应环境地址+接口地址，例如：

https://schm-api-test.shiseido.cn/schm-inbound-sap-eapi/api/v1/inbound/oms

4.接口调用说明

4.1 ToC 销售单明细上传

请求接口: /inbound/oms
接口描述: ToC 销售单明细上传接口
请求类型: HTTP POST

4.1.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
公司代码	COMPANYCD	VARCHAR	3	是
单据申请单号/OMS出库单号	APPLYNO	VARCHAR	35	是
订单类型	APPLYTYPE	VARCHAR	4	是	20 门店销售、21 门店退货、30 免费销售单、31 免费单退货
订单申请日期/OMS出库日期	APPLYYMD	VARCHAR	10	是
商店代码	CUSTOMERCD	VARCHAR	10	是
ShipTo代码	SAP_CUSTOMERCD	VARCHAR	10
客户分类	SALEPATN	VARCHAR	2	是	K1-经销店、K2-代销店、FS-直营店
订单原因	REASONCD	VARCHAR	3
POS区分	CustomerGroup1	VARCHAR	4	是	"Z201 SMILE POS, Z202 PS POS, Z203 E-ORDER, Z204 CS POS, Z205 SCHD, Z206 Others, Z207 OMS, Z208 ONECX"
促销事件	PromotionEvents	VARCHAR	35
文本/OMS平台订单号	TXT_FormHeader	VARCHAR	200
文本/OMS支付日期	TXT_HeaderNote	VARCHAR	200
成本中心	CostCenter	VARCHAR	10
决裁案件番号	imw_matter_number	VARCHAR	20
申请员工工号	EMPCODE	VARCHAR	20
申请员工姓名	EMPNAME	VARCHAR	20
订单来源	orderSource	VARCHAR	500
品牌编码	brandCode	VARCHAR	500
销售平台	channelCode	VARCHAR	500
订单类型	orderType	INT
订单状态	orderStatus	VARCHAR	500
支付方式	payType	VARCHAR	500
支付状态	payStatus	INT
出入库状态	shippedStatus	INT
会员识别号	memberId	VARCHAR	500
店铺名称	shopName	VARCHAR	500
源平台单号	parentPayCode	VARCHAR	500
订单生成时间	orderTime	VARCHAR	500
订单生成时间	payTime	VARCHAR	500
应付金额	amount	VARCHAR	500
修正金额	reviseAmount	VARCHAR	500
销售订单行项目	POSEX	VARCHAR	6	是
物料确定号	DETERMINECODE	VARCHAR	13	是
工厂	PLANT	VARCHAR	8
库位代码	LGORT	VARCHAR	8
订单数量	APPLYQNTY	INT		是
销售金额	actualMNY	number	11
免费品标识	Freegoods	CHAR	1
批次号	CHARG	VARCHAR	10
用途	USECODE	CHAR	3
决裁案件号	DecisionNo	VARCHAR	20
物料编码	prdCode	VARCHAR	500
产品名称	prdName	VARCHAR	500
发货时间	shippedTime	VARCHAR	500
时间戳（当前时间）	Timestamp	datetime	20	是	同一单的时间戳相同，2024-07-14 16:48:30.710
周边标识	SysFlg	CHAR	1		"由Mule分配的Cliend Id进行转换 1-POS, 2-SCHD, 3-E-order, 4-Shopex, 5-UCO, 6-LeQee, 7-决裁, 8-采购"
不启用最小起订量标识	SDABWFLG	CHAR	1		"1-不启用最小起订量 0或空-启用"
汇总单号	DailySummaryNo	VARCHAR	35
单据类型	documentType	VARCHAR	35		0：默认、1：拆单、2：合单
平台销售单号	TXT_FormDetail	VARCHAR	35
预售标志	PresaleFlag	VARCHAR	1		0：普通销售、1：预售、2：预售提货、3：团购券购买、4：团购券提货
预售交易单号	PresaleTradeNo	VARCHAR	500
BC代码	BCCode	VARCHAR	10

4.1.2 参数示例

注意: 每次调用传一整单数据，按item级生成多条数据，比如订单里有多个item级，则按item级生成多个条目。

[
    {
        "COMPANYCD": "785",
        "APPLYNO": "QTC1024071001267002913",
        "APPLYTYPE": "30",
        "APPLYYMD": "20240722",
        "CUSTOMERCD": "2200004135",
        "SAP_CUSTOMERCD": "2200004135",
        "SALEPATN": "FS",
        "REASONCD": "568",
        "CustomerGroup1": "Z207",
        "PromotionEvents": "",
        "TXT_FormHeader": "QTC1024071001267002913",
        "TXT_HeaderNote": "20240722",
        "CostCenter": "",
        "imw_matter_number": "",
        "EMPCODE": "",
        "EMPNAME": "",
        "orderSource": "乐其",
        "brandCode": "TG",
        "channelCode": "tmall",
        "orderType": 3,
        "orderStatus": "1",
        "payType": "none",
        "payStatus": 0,
        "shippedStatus": 2,
        "memberId": "",
        "shopName": "TG天猫官方旗舰店",
        "parentPayCode": "QTC1024071001267002913",
        "orderTime": "2024-07-22 09:52:20",
        "payTime": "",
        "amount": "0",
        "reviseAmount": "0",
        "POSEX": "10",
        "DETERMINECODE": "74381688801",
        "PLANT": "785A",
        "LGORT": "W001",
        "APPLYQNTY": 140,
        "actualMNY": 0.00,
        "Freegoods": "",
        "CHARG": "",
        "USECODE": "",
        "DecisionNo": "0000164547",
        "prdCode": "74381688801",
        "prdName": "THE GINZa 2108 EC 快递外箱 纸箱(官网)",
        "shippedTime": "2024-07-22 09:52:20",
    "TXT_FormDetail": "QTC1024071001267002913"
        "Timestamp": "2024-07-14 16:48:30.710",
        "SysFlg": "",
        "SDABWFLG": "",
        "DailySummaryNo": "",
        "documentType": ""

    },
    {
    "COMPANYCD": "785",
        "APPLYNO": "QTC1024071001267002913",
        "APPLYTYPE": "30",
        "APPLYYMD": "20240722",
        "CUSTOMERCD": "2200004135",
        "SAP_CUSTOMERCD": "2200004135",
        "SALEPATN": "FS",
        "REASONCD": "568",
        "CustomerGroup1": "Z207",
        "PromotionEvents": "",
        "TXT_FormHeader": "QTC1024071001267002913",
        "TXT_HeaderNote": "20240722",
        "CostCenter": "",
        "imw_matter_number": "",
        "EMPCODE": "",
        "EMPNAME": "",
        "orderSource": "乐其",
        "brandCode": "TG",
        "channelCode": "tmall",
        "orderType": 3,
        "orderStatus": "1",
        "payType": "none",
        "payStatus": 0,
        "shippedStatus": 2,
        "memberId": "",
        "shopName": "TG天猫官方旗舰店",
        "parentPayCode": "QTC1024071001267002913",
        "orderTime": "2024-07-22 09:52:20",
        "payTime": "",
        "amount": "0",
        "reviseAmount": "0",
        "POSEX": "20",
        "DETERMINECODE": "74381714801",
        "PLANT": "785A",
        "LGORT": "W001",
        "APPLYQNTY": 53,
        "actualMNY": 0.00,
        "Freegoods": "",
        "CHARG": "",
        "USECODE": "",
        "DecisionNo": "0000164547",
        "prdCode": "74381714801",
        "prdName": "THE GINZa 2108 EC 外箱封箱胶带 封箱带(官网)",
        "shippedTime": "2024-07-22 09:52:20",
        "TXT_FormDetail": "QTC1024071001267002913",
    "Timestamp": "2024-07-14 16:48:30.710",
        "SysFlg": "",
        "SDABWFLG": "",
        "DailySummaryNo": "",
        "documentType": ""
    },
    {
    "COMPANYCD": "785",
        "APPLYNO": "QTC1024071001267002913",
        "APPLYTYPE": "30",
        "APPLYYMD": "20240722",
        "CUSTOMERCD": "2200004135",
        "SAP_CUSTOMERCD": "2200004135",
        "SALEPATN": "FS",
        "REASONCD": "568",
        "CustomerGroup1": "Z207",
        "PromotionEvents": "",
        "TXT_FormHeader": "QTC1024071001267002913",
        "TXT_HeaderNote": "20240722",
        "CostCenter": "",
        "imw_matter_number": "",
        "EMPCODE": "",
        "EMPNAME": "",
        "orderSource": "乐其",
        "brandCode": "TG",
        "channelCode": "tmall",
        "orderType": 3,
        "orderStatus": "1",
        "payType": "none",
        "payStatus": 0,
        "shippedStatus": 2,
        "memberId": "",
        "shopName": "TG天猫官方旗舰店",
        "parentPayCode": "QTC1024071001267002913",
        "orderTime": "2024-07-22 09:52:20",
        "payTime": "",
        "amount": "0",
        "reviseAmount": "0",
        "POSEX": "30",
        "DETERMINECODE": "74380655801",
        "PLANT": "785A",
        "LGORT": "W001",
        "APPLYQNTY": 1193,
        "actualMNY": 0.00,
        "Freegoods": "",
        "CHARG": "",
        "USECODE": "",
        "DecisionNo": "0000164547",
        "prdCode": "74380655801",
        "prdName": "THE GINZa 2104 TG BH2021 雪梨纸 包装纸(全渠道)",
        "shippedTime": "2024-07-22 09:52:20",
        "TXT_FormDetail": "QTC1024071001267002913",
        "Timestamp": "2024-07-14 16:48:30.710",
        "SysFlg": "",
        "SDABWFLG": "",
        "DailySummaryNo": "",
        "documentType": ""
    },
    {
    "COMPANYCD": "785",
        "APPLYNO": "QTC1024071001267002913",
        "APPLYTYPE": "30",
        "APPLYYMD": "20240722",
        "CUSTOMERCD": "2200004135",
        "SAP_CUSTOMERCD": "2200004135",
        "SALEPATN": "FS",
        "REASONCD": "568",
        "CustomerGroup1": "Z207",
        "PromotionEvents": "",
        "TXT_FormHeader": "QTC1024071001267002913",
        "TXT_HeaderNote": "20240722",
        "CostCenter": "",
        "imw_matter_number": "",
        "EMPCODE": "",
        "EMPNAME": "",
        "orderSource": "乐其",
        "brandCode": "TG",
        "channelCode": "tmall",
        "orderType": 3,
        "orderStatus": "1",
        "payType": "none",
        "payStatus": 0,
        "shippedStatus": 2,
        "memberId": "",
        "shopName": "TG天猫官方旗舰店",
        "parentPayCode": "QTC1024071001267002913",
        "orderTime": "2024-07-22 09:52:20",
        "payTime": "",
        "amount": "0",
        "reviseAmount": "0",
        "POSEX": "40",
        "DETERMINECODE": "74380729801",
        "PLANT": "785A",
        "LGORT": "W001",
        "APPLYQNTY": 2160,
        "actualMNY": 0.00,
        "Freegoods": "",
        "CHARG": "",
        "USECODE": "",
        "DecisionNo": "0000164547",
        "prdCode": "74380729801",
        "prdName": "THE GINZa 2104 TG BH2021 logo贴 标签贴(全渠道)",
        "shippedTime": "2024-07-22 09:52:20",
        "TXT_FormDetail": "QTC1024071001267002913",
    "Timestamp": "2024-07-14 16:48:30.710",
        "SysFlg": "",
        "SDABWFLG": "",
        "DailySummaryNo": "",
        "documentType": ""
    },
    {
    "COMPANYCD": "785",
        "APPLYNO": "QTC1024071001267002913",
        "APPLYTYPE": "30",
        "APPLYYMD": "20240722",
        "CUSTOMERCD": "2200004135",
        "SAP_CUSTOMERCD": "2200004135",
        "SALEPATN": "FS",
        "REASONCD": "568",
        "CustomerGroup1": "Z207",
        "PromotionEvents": "",
        "TXT_FormHeader": "QTC1024071001267002913",
        "TXT_HeaderNote": "20240722",
        "CostCenter": "",
        "imw_matter_number": "",
        "EMPCODE": "",
        "EMPNAME": "",
        "orderSource": "乐其",
        "brandCode": "TG",
        "channelCode": "tmall",
        "orderType": 3,
        "orderStatus": "1",
        "payType": "none",
        "payStatus": 0,
        "shippedStatus": 2,
        "memberId": "",
        "shopName": "TG天猫官方旗舰店",
        "parentPayCode": "QTC1024071001267002913",
        "orderTime": "2024-07-22 09:52:20",
        "payTime": "",
        "amount": "0",
        "reviseAmount": "0",
        "POSEX": "50",
        "DETERMINECODE": "74380790801",
        "PLANT": "785A",
        "LGORT": "W001",
        "APPLYQNTY": 598,
        "actualMNY": 0.00,
        "Freegoods": "",
        "CHARG": "",
        "USECODE": "",
        "DecisionNo": "0000164547",
        "prdCode": "74380790801",
        "prdName": "THE GINZa 2106 TG BH2021 拉菲草 纸丝(全渠道)",
        "shippedTime": "2024-07-22 09:52:20",
        "TXT_FormDetail": "QTC1024071001267002913",
        "Timestamp": "2024-07-14 16:48:30.710",
        "SysFlg": "",
        "SDABWFLG": "",
        "DailySummaryNo": "",
        "documentType": ""
    },
    {
    "COMPANYCD": "785",
        "APPLYNO": "QTC1024071001267002913",
        "APPLYTYPE": "30",
        "APPLYYMD": "20240722",
        "CUSTOMERCD": "2200004135",
        "SAP_CUSTOMERCD": "2200004135",
        "SALEPATN": "FS",
        "REASONCD": "568",
        "CustomerGroup1": "Z207",
        "PromotionEvents": "",
        "TXT_FormHeader": "QTC1024071001267002913",
        "TXT_HeaderNote": "20240722",
        "CostCenter": "",
        "imw_matter_number": "",
        "EMPCODE": "",
        "EMPNAME": "",
        "orderSource": "乐其",
        "brandCode": "TG",
        "channelCode": "tmall",
        "orderType": 3,
        "orderStatus": "1",
        "payType": "none",
        "payStatus": 0,
        "shippedStatus": 2,
        "memberId": "",
        "shopName": "TG天猫官方旗舰店",
        "parentPayCode": "QTC1024071001267002913",
        "orderTime": "2024-07-22 09:52:20",
        "payTime": "",
        "amount": "0",
        "reviseAmount": "0",
        "POSEX": "60",
        "DETERMINECODE": "78704625101",
        "PLANT": "785A",
        "LGORT": "W001",
        "APPLYQNTY": 10,
        "actualMNY": 0.00,
        "Freegoods": "",
        "CHARG": "",
        "USECODE": "",
        "DecisionNo": "0000164547",
        "prdCode": "78704625101",
        "prdName": "THE GINZA 2404 御银座节日封套M 封套 （全渠道）",
        "shippedTime": "2024-07-22 09:52:20",
        "TXT_FormDetail": "QTC1024071001267002913",
    "Timestamp": "2024-07-14 16:48:30.710",
        "SysFlg": "",
        "SDABWFLG": "",
        "DailySummaryNo": "",
        "documentType": ""
    }
]

4.1.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功，"error"表示失败
数量	count	int	是	上传的数量
唯一标识id	DocumentIDs	array	是	订单唯一标识id
失败信息	message	String	否	当status为error时，会返回message错误信息

4.1.4 返回值示例

成功
{
    "status": "success",
    "count": 6,
    "DocumentIDs": ["e32df223333sadfewf"]
}
失败
{
    "status": "error",
    "message": ""
}

4.2 ToB 业务单据上传接口

请求接口: /inbound/pos
接口描述: ToB 业务单据上传接口
请求类型: HTTP POST

4.2.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
公司代码	COMPANYCD	VARCHAR	3	是
单据申请单号/OMS出库单号	APPLYNO	VARCHAR	35	是
订单类型	APPLYTYPE	VARCHAR	4	是	10 补货到门店、11 店头退仓(SAP发起)、12 POD确认单、13 店头退仓(POS发起)和代销、直营换货、 20 门店销售、21 门店退货、30 免费销售单、31 免费单退货、32 SAP发起免费单、 33 POS发起纯免费退仓、34 内部领用 2B专用(周边发起)、40 借项凭证（业主）、41 贷项凭证（FSS)、 42 借项凭证（退货金额小于换货金额）、43 贷项凭证（退货金额大于换货金额）、50 换货出库（POS换入）、51 换货入库（POS换出）
订单申请日期/OMS出库日期	APPLYYMD	VARCHAR	10	是
商店代码	CUSTOMERCD	VARCHAR	10	是
ShipTo代码	SAP_CUSTOMERCD	VARCHAR	10
客户分类	SALEPATN	VARCHAR	2	是	K1-经销店、K2-代销店、FS-直营店
订单原因	REASONCD	VARCHAR	3
POS区分	CustomerGroup1	VARCHAR	4	是	"Z201 SMILE POS, Z202 PS POS, Z203 E-ORDER, Z204 CS POS, Z205 SCHD, Z206 Others, Z207 OMS, Z208 ONECX"
促销事件	PromotionEvents	VARCHAR	35
文本/OMS平台订单号	TXT_FormHeader	VARCHAR	200		POS传支付订单号
文本/OMS支付日期	TXT_HeaderNote	VARCHAR	200
成本中心	CostCenter	VARCHAR	10
决裁案件番号	imw_matter_number	VARCHAR	20
申请员工工号	EMPCODE	VARCHAR	20
申请员工姓名	EMPNAME	VARCHAR	20
销售订单行项目	POSEX	VARCHAR	6	是
物料确定号	DETERMINECODE	VARCHAR	13	是
工厂	PLANT	VARCHAR	8
库位代码	LGORT	VARCHAR	8
订单数量	APPLYQNTY	INT		是
销售金额	actualMNY	number	11
免费品标识	Freegoods	CHAR	1
批次号	CHARG	VARCHAR	10
用途	USECODE	CHAR	3
决裁案件号	DecisionNo	VARCHAR	20
时间戳（当前时间）	Timestamp	datetime	20	是	同一单的时间戳相同，2024-07-14 16:48:30.710
周边标识	SysFlg	CHAR	1		"由Mule分配的Cliend Id进行转换 1-POS, 2-SCHD, 3-E-order, 4-Shopex, 5-UCO, 6-LeQee, 7-决裁, 8-采购"
不启用最小起订量标识	SDABWFLG	CHAR	1		"1-不启用最小起订量 0或空-启用"
IO号	IONum	VARCHAR	10		1234567890

4.2.2 参数示例

注意: 每次调用传一整单数据，按item级生成多条数据，比如订单里有多个item级，则按item级生成多个条目。

[
  {
    "COMPANYCD": "785",
    "APPLYNO": "RCXXXXXXXXXXXXXXX",
    "APPLYTYPE": "20",
    "APPLYYMD": "20220428",
    "CUSTOMERCD": "00200001",
    "SAP_CUSTOMERCD": "1000200001",
    "SALEPATN": "K2",
    "REASONCD": "564",
    "CustomerGroup1": "Z202",
    "PromotionEvents": "促销",
    "TXT_FormHeader": "3889942344064221567",
    "TXT_HeaderNote": "20240710",
    "CostCenter": "78599D11A7",
    "imw_matter_number": "0000163791",
    "EMPCODE": "001001",
    "EMPNAME": "Zhang San",
    "POSEX": "10",
    "DETERMINECODE": "730852143449",
    "PLANT": "Plan",
    "LGORT": "W001",
    "APPLYQNTY": 3,
    "actualMNY": 480.00,
    "Freegoods": "1",
    "CHARG": "COMMON",
    "USECODE": "",
    "DecisionNo": "AR028786-001",
    "Timestamp": "2024-07-14 16:48:30.710",
    "SysFlg": "1",
    "SDABWFLG": "1",
    "IONum": "1234567890"
  }
]

4.2.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功，"error"表示失败
数量	count	int	是	上传的数量
唯一标识id	DocumentIDs	array	是	订单唯一标识id
失败信息	message	String	否	当status为error时，会返回message错误信息

4.1.4 返回值示例

成功
{
    "status": "success",
    "count": 1,
    "DocumentIDs": ["e32df223333sadfewf"]
}
失败
{
    "status": "error",
    "message": ""
}

4.3 ToB 采购单据上传

请求接口: /inbound/purchase
接口描述: ToB 采购单据上传接口
请求类型: HTTP POST

4.3.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
公司代码	CoCode	VARCHAR	4	是
订单类型	APPLYTYPE	VARCHAR	4	是
订单类型	OrderType	VARCHAR	4	是
创建日期	CreateDate	VARCHAR	8	是
创建者	CreateBy	VARCHAR	12	是
SAP供应商编号	Vendor	VARCHAR	10	是
Language Key语言	Language	VARCHAR	1	是
采购组织	PurOrg	VARCHAR	4	是
采购组	PurGrp	VARCHAR	3	是
币种	Currency	VARCHAR	5	是
下单日期	DOC_DATE	VARCHAR	8	是
我们的参考	Reference	VARCHAR	12	是
采购订单明细编号	ItemNo	VARCHAR	5	是
短文本	ShortText	VARCHAR	40
SAP商品编号	ItemCode	VARCHAR	18	是
工厂	Plant	VARCHAR	4	是
库位	STGE_LOC	VARCHAR	4	是
采购订单编号	NPSPONo	VARCHAR	10	是
物料组	MaterialGroup	VARCHAR	9	是
数量	Quantity	INT	13	是
订单单位	PO_UNIT	VARCHAR	3	是
税代码	TAX_CODE	VARCHAR	2	是
科目分配类别	ACCTASSCAT	VARCHAR	1
免费货特殊标识	Free	VARCHAR	1
确认控制码	ControlKey	VARCHAR	4
退货标识	Return	VARCHAR	1
申请人	Requester	VARCHAR	12	是
内部订单	Internalorder	VARCHAR	18
总账科目	GL_ACCOUNT	VARCHAR	10
单价	Netprice	VARCHAR	11	是
价格单位	PRICE_UNIT	VARCHAR	5	是
交货日期	DeliveryDate	DATS	8	是
预算单价	POINTS	number		是
时间戳（当前时间）	Timestamp	datetime	20	是	2024-07-14 16:48:30.710

4.3.2 参数示例

注意: 每次调用传一整单数据，按item级生成多条数据，比如订单里有多个item级，则按item级生成多个条目。

[
  {
        "CoCode": "785",
        "APPLYTYPE": "14",
        "OrderType": "Z4NB",
        "CreateDate": "20240618",
        "CreateBy": "30018426",
        "Vendor": "2100003028",
        "Language": "1",
        "PurOrg": "2001",
        "PurGrp": "220",
        "Currency": "CNY",
        "DOC_DATE": "20240619",
        "Reference": "INTRAMART",
        "ItemNo": "00010",
        "ShortText": "",
        "ItemCode": "78704995101",
        "Plant": "785V",
        "STGE_LOC": "H001",
        "NPSPONo": "PO2406163",
        "MaterialGroup": "",
        "Quantity": 150,
        "PO_UNIT": "EA",
        "TAX_CODE": "J1",
        "ACCTASSCAT": "",
        "Free": "",
        "ControlKey": "",
        "Return": "",
        "Requester": "30018426",
        "Internalorder": "",
        "GL_ACCOUNT": "",
        "Netprice": "4.28",
        "PRICE_UNIT": "1",
        "DeliveryDate": "20240708",
        "POINTS": 4.47,
        "Timestamp": "2024-07-14 16:48:30.710"
    }
]

4.3.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功，"error"表示失败
数量	count	int	是	上传的数量
唯一标识id	DocumentIDs	array	是	订单唯一标识id
失败信息	message	String	否	当status为error时，会返回message错误信息

4.1.4 返回值示例

成功
{
    "status": "success",
    "count": 1,
    "DocumentIDs": ["e32df223333sadfewf"]
}
失败
{
    "status": "error",
    "message": ""
}

4.4 ToC 进行中销售单上传（对账用）接口

请求接口: /inbound/inprogress
接口描述: ToC 进行中销售单上传（对账用）接口
请求类型: HTTP POST

4.4.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
订单来源	orderSource	VARCHAR	500	是	POS
品牌编码	brandCode	VARCHAR	500	是	品牌编码，仅接收如下编码：CPB、EFM、IPSA、NARS、TG、SDK、SHI、PCV、LM、BAUM
销售平台	channelCode	VARCHAR	500	是	web：官网 wx_ma：微信小程序 wx_video：微信视频号 tmall：天猫 tiktok：抖音小红书：xhs
平台销售单号（商户订单号）	TXT_FormHeader	VARCHAR	200	是	平台销售单号（商户订单号）
订单生成时间	orderTime	VARCHAR	500	是
订单付款时间	TXT_HeaderNote	VARCHAR	200
付款金额	payAmount	VARCHAR	500	是
退款金额	refundAmount	VARCHAR	500	是
运费	freight	VARCHAR	500
交易状态	transactionStatus	INT		是	基础： 1. 交易完成 2. 交易关闭 3. 未付款（订单创建） 4. 已付款（已付款未发货） 9. 未知天猫： 10. 交易完成（交易成功） 11. 交易关闭（付款以后用户退款成功） 12. 没有创建支付宝交易 13. 等待买家付款 14. 卖家部分发货 15. 等待卖家发货（买家已付款） 16. 等待买家确认收货（卖家已发货） 17. 买家已签收（货到付款专用） 18. 付款以前，卖家或买家主动关闭交易 21. 定金未付尾款未付 22. 定金已付尾款未付 23. 定金和尾款都付 24. 预售定金罚没抖音： 40. 交易完成后（已完成-已收货） 41. 交易关闭（已取消） 42. 订单创建完毕 43. 已支付 44. 备货中 45. 部分发货 46. 已发货（全部发货）
推送状态	pushStatus	INT		是	1. 已推送，指已经推送到S4的单据。 2. 未推送，是指应该推送暂时还未推送到S4的单据。 3. 不用推送，不用推送到S4的单据。
时间戳（当前时间）	Timestamp	VARCHAR	20	是	同一单的时间戳相同：2024-07-14 16:48:30.710
周边标识	SysFlg	CHAR	1	是	1-POS 2-SCHD 3-E-order 4-Shopex 5-UCO 6-LeQee 7-决裁 8-采购

4.4.2 参数示例

注意: 支持多单，每单都是一个条目。

[{
  "orderSource": "UCO",
  "brandCode": "CPB",
  "channelCode": "tmall",
  "TXT_FormHeader": "3889942344064221567",
  "orderTime": "2024-07-10 10:42:44",
  "TXT_HeaderNote": "3425027475214591645",
  "payAmount": "350.00",
  "refundAmount": "0",
  "freight": "0.00",
  "transactionStatus": 15,
  "pushStatus": 2,
  "Timestamp": "2024-07-14 16:48:30.710",
  "SysFlg": "7"
},
{
  "orderSource": "UCO",
  "brandCode": "CPB",
  "channelCode": "tmall",
  "TXT_FormHeader": "3889942344064221567",
  "orderTime": "2024-07-10 10:42:44",
  "TXT_HeaderNote": "3425027475214591645",
  "payAmount": "350.00",
  "refundAmount": "0",
  "freight": "0.00",
  "transactionStatus": 15,
  "pushStatus": 2,
  "Timestamp": "2024-07-14 16:48:30.710",
  "SysFlg": "7"
},
{
  "orderSource": "UCO",
  "brandCode": "CPB",
  "channelCode": "tmall",
  "TXT_FormHeader": "3889942344064221567",
  "orderTime": "2024-07-10 10:42:44",
  "TXT_HeaderNote": "3425027475214591645",
  "payAmount": "350.00",
  "refundAmount": "0",
  "freight": "0.00",
  "transactionStatus": 15,
  "pushStatus": 2,
  "Timestamp": "2024-07-14 16:48:30.710",
  "SysFlg": "7"
}]

4.4.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功，"error"表示失败
数量	count	int	是	上传的数量
唯一标识id	DocumentIDs	array	是	订单唯一标识id
失败信息	message	String	否	当status为error时，会返回message错误信息

4.4.4 返回值示例

成功
{
    "status": "success",
    "count": 3,
    "DocumentIDs": ["e32df223333sadfewf"]
}
失败
{
    "status": "error",
    "message": ""
}

4.5 ToC 金额调整单上传（对账用）接口

请求接口: /inbound/revise
接口描述: ToC 金额调整单上传（对账用）接口
请求类型: HTTP POST

4.5.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
订单来源	orderSource	VARCHAR	500	是	POS
品牌编码	brandCode	VARCHAR	500	是	品牌编码，仅接收如下编码： CPB、EFM、IPSA、NARS、TG、SDK、SHI、PCV、LM、BAUM
销售平台	channelCode	VARCHAR	500	是	web：官网 wx_ma：微信小程序 wx_video：微信视频号 tmall：天猫 tiktok：抖音小红书：xhs
revise	ID	VARCHAR	100
单据编号	APPLYNO	char	35	是	POS 单号、OMS 出库单号
业务类型	APPLYTYPE	char	3	是	10补货到门店 11退货到公司 20门店销售 21门店退货 30免费销售单 31免费单退货
订单类型	orderType	INT		是	固定值：11
商店代码	CUSTOMERCD	char	10	是	周边商店代码
SAP Shipto代码	SAP_CUSTOMERCD	char	10	是	店铺编码
文本/OMS平台订单号	TXT_FormHeader	VARCHAR	200	是	POS传支付订单号
修正金额	reviseAmount	VARCHAR	500	是
修正金额的时间	reviseTime	VARCHAR	100	是	修正金额的时间，格式 yyyy-MM-dd hh:mm:ss
订单原因（Head）	REASONCD	char	3	是	1：物料修正 2：订单修正说明： 1.对物料金额进行修正，要修正的订单中必须包含此物料； 2.对订单总金额进行修正，物料需要使用运费修正。
物料编码	prdCode	VARCHAR	500	是	物料编码
物料确定号	DETERMINECODE	char	13	是	物料确定号
产品名称	prdName	VARCHAR	500	是	产品名称
修正金额	reviseAmount_ITEM	VARCHAR	500	是	物料修正金额，区分正负值，按实际情况填写
时间戳（当前时间）	Timestamp	datetime	20	是	同一单的时间戳相同：2024-07-14 16:48:30.710
周边标识	SysFlg	CHAR	1	是	1-POS 2-SCHD 3-E-order 4-Shopex 5-UCO 6-LeQee 7-决裁 8-采购

4.5.2 参数示例

注意: 支持多单，按item级生成多条数据，比如订单里有多个item级，则按item级生成多个条目。

[{
  "orderSource": "UCO",
  "brandCode": "CPB",
  "channelCode": "tmall",
  "ID": "1806847913",
  "APPLYNO": "1908083850",
  "APPLYTYPE": "20",
  "orderType": 11,
  "CUSTOMERCD": "31400000",
  "SAP_CUSTOMERCD": "2200003902",
  "TXT_FormHeader": "3889942344064221567",
  "reviseAmount": "-50.00",
  "reviseTime": "2024-04-05 09:47:13",
  "REASONCD": "2",
  "prdCode": "300000290",
  "DETERMINECODE": "300000290",
  "prdName": "NARS 官网运费",
  "reviseAmount_ITEM": "-50",
  "Timestamp": "2024-07-14 16:48:30.710",
  "SysFlg": "7"
},
{
  "orderSource": "UCO",
  "brandCode": "CPB",
  "channelCode": "tmall",
  "ID": "1806847913",
  "APPLYNO": "1908083850",
  "APPLYTYPE": "20",
  "orderType": 11,
  "CUSTOMERCD": "31400000",
  "SAP_CUSTOMERCD": "2200003902",
  "TXT_FormHeader": "3889942344064221567",
  "reviseAmount": "-50.00",
  "reviseTime": "2024-04-05 09:47:13",
  "REASONCD": "2",
  "prdCode": "300000290",
  "DETERMINECODE": "300000290",
  "prdName": "NARS 官网运费",
  "reviseAmount_ITEM": "-50",
  "Timestamp": "2024-07-14 16:48:30.710",
  "SysFlg": "7"
},
{
  "orderSource": "UCO",
  "brandCode": "CPB",
  "channelCode": "tmall",
  "ID": "1806847913",
  "APPLYNO": "1908083850",
  "APPLYTYPE": "20",
  "orderType": 11,
  "CUSTOMERCD": "31400000",
  "SAP_CUSTOMERCD": "2200003902",
  "TXT_FormHeader": "3889942344064221567",
  "reviseAmount": "-50.00",
  "reviseTime": "2024-04-05 09:47:13",
  "REASONCD": "2",
  "prdCode": "300000290",
  "DETERMINECODE": "300000290",
  "prdName": "NARS 官网运费",
  "reviseAmount_ITEM": "-50",
  "Timestamp": "2024-07-14 16:48:30.710",
  "SysFlg": "7"
}]

4.5.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功，"error"表示失败
数量	count	int	是	上传的数量
唯一标识id	DocumentIDs	array	是	订单唯一标识id
失败信息	message	String	否	当status为error时，会返回message错误信息

4.5.4 返回值示例

成功
{
    "status": "success",
    "count": 3,
    "DocumentIDs": ["e32df223333sadfewf"]
}
失败
{
    "status": "error",
    "message": ""
}

4.6 POS传送对账平台的借贷支付方式

请求接口: /inbound/coupoChargePlatform
接口描述: POS传送对账平台的借贷支付方式
请求类型: HTTP POST

4.6.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
店铺代码	shopCode	VARCHAR	10
店铺名称	shopName	VARCHAR	500
POS机号	posNo	VARCHAR	500		固定值：1
终端机号	deviceNo	VARCHAR	500		固定值：1
交易号	tradeNo	VARCHAR	500
小票号	invoiceNumber	VARCHAR	500	是
POS唯一订单号	posTradeNo	VARCHAR	500	是
销售类型	saleType	VARCHAR	500	是
发生时间（支付发送时间）	tradeTime	datetime	500	是
营业日期（日结时间）	businessDate	date	500	是
支付方式编码	payTypeCode	VARCHAR	500	是	1：抵扣券（未来不再使用） 15：中信刷卡（未来不再使用） 16：中信支付宝（未来不再使用） 17：中信微信（未来不再使用） 18：中信二维码（未来不再使用） 51：现金 52：二维码支付（POS收银台的二维码） 53：小猫卡 58：扫码支付 59：二维码支付（易生支付收银台的二维码未来不在使用） 60：电子货币（未来不再使用） 61：移动POS（使用易生收款POS机扫描顾客二维码收款） 63：新天地活动券 64：其他（POS只允许传红色标记的几种方式）
支付方式名称	payTypeNm	VARCHAR	500	是
卡类型	cardType	VARCHAR	500
金额	amount	Double	500	是
内部支付订单号	posPayNo	VARCHAR	500	是
商户订单号	merchantOrderNo	VARCHAR	500	是
平台交易号	platformTradeNo	VARCHAR	500	是
周边标识	SysFlg	CHAR	1		1-POS 2-SCHD 3-E-order 4-Shopex 5-UCO 6-LeQee 7-决裁 8-采购
时间戳（当前时间）	Timestamp	datetime		是	同一单的时间戳相同

4.6.2 参数示例

注意: 每次调用传一整单数据，按item级生成多条数据，比如订单里有多个item级，则按item级生成多个条目。

[
    {
        "shopCode": "SC001",
        "shopName": "旗舰店",
        "posNo": "1",
        "deviceNo": "1",
        "tradeNo": "TRADE123456",
        "invoiceNumber": "INV123456",
        "posTradeNo": "POSTRADE123456",
        "saleType": "普通销售",
        "tradeTime": "2024-11-26T10:30:00",
        "businessDate": "2024-11-26",
        "payTypeCode": "51",
        "payTypeNm": "现金",
        "cardType": "普通会员卡",
        "amount": 150.75,
        "posPayNo": "PAY123456",
        "merchantOrderNo": "MORD123456",
        "platformTradeNo": "PLTTRADE123456",
        "SysFlg": "1",
        "Timestamp": "2024-11-26T10:30:00"
    },
    {
        "shopCode": "SC001",
        "shopName": "旗舰店",
        "posNo": "1",
        "deviceNo": "1",
        "tradeNo": "TRADE123456",
        "invoiceNumber": "INV123456",
        "posTradeNo": "POSTRADE123456",
        "saleType": "普通销售",
        "tradeTime": "2024-11-26T10:30:00",
        "businessDate": "2024-11-26",
        "payTypeCode": "51",
        "payTypeNm": "现金",
        "cardType": "普通会员卡",
        "amount": 150.75,
        "posPayNo": "PAY123456",
        "merchantOrderNo": "MORD123456",
        "platformTradeNo": "PLTTRADE123456",
        "SysFlg": "1",
        "Timestamp": "2024-11-26T10:30:00"
    },
    {
        "shopCode": "SC001",
        "shopName": "旗舰店",
        "posNo": "1",
        "deviceNo": "1",
        "tradeNo": "TRADE123456",
        "invoiceNumber": "INV123456",
        "posTradeNo": "POSTRADE123456",
        "saleType": "普通销售",
        "tradeTime": "2024-11-26T10:30:00",
        "businessDate": "2024-11-26",
        "payTypeCode": "51",
        "payTypeNm": "现金",
        "cardType": "普通会员卡",
        "amount": 150.75,
        "posPayNo": "PAY123456",
        "merchantOrderNo": "MORD123456",
        "platformTradeNo": "PLTTRADE123456",
        "SysFlg": "1",
        "Timestamp": "2024-11-26T10:30:00"
    }
]

4.6.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功，"error"表示失败
数量	count	int	是	上传的数量
唯一标识id	DocumentIDs	array	是	订单唯一标识id
失败信息	message	String	否	当status为error时，会返回message错误信息

4.6.4 返回值示例

成功
{
    "status": "success",
    "count": 3,
    "DocumentIDs": ["e32df223333sadfewf"]
}
失败
{
    "status": "error",
    "message": ""
}

4.7 POS回传直营店到货状态

请求接口: /businessSubtbl/update
接口描述: POS回传直营店到货状态
请求类型: HTTP PUT

4.7.1 参数说明

注意: 参数作为查询条件（queryParams）。

字段描述	字段名称	类型	长度
单据编号	APPLYNO	char	35
业务类型	BusinessType	char	3
商店代码	CUSTOMERCD	char	10
状态字	STATUS	char	1
接口运行标志	IFFlg	char	1

注意: body中的参数（需要传入更新的值）。

字段描述	字段名称	类型	长度	必填	备注
状态字	STATUS	char	1	是
接口运行标志	IFFlg	char	1	是
更新人	UPDATEMAN	char	20	是
更新时间	UPDATETIME	datetime		是	如2024-11-29 17:50:22.000

4.7.2 请求参数示例

接口请求示例：
/api/v1/businessSubtbl/update?APPLYNO=1800028452&BusinessType=2&CUSTOMERCD=1&STATUS=2&IFFlg=1

body参数:

{
    "STATUS": "3",
    "IFFlg": "1",
    "UPDATEMAN": "EAI-TEST",
    "UPDATETIME": "2024-11-29 17:50:22.000"
}

4.7.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功，"error"表示失败
主表更新的行数	businessMainRows	int	是
子表更新的行数	businessSubRows	int	是
失败信息	message	String	否	当status为error时，会返回message错误信息

4.7.4 返回值示例

成功
{
    "status": "success",
    "businessMainRows": 2,
    "businessSubRows": 2
}
失败
{
    "status": "error",
    "message": ""
}

API Reference (Chinese Version)

schm-inbound-sap-eapi

1.身份认证

注意:

2.检查连通性:

3.接口总览:

4.接口调用说明

4.1 ToC 销售单明细上传

4.1.1 参数说明

4.1.2 参数示例

4.1.3 返回值说明

4.1.4 返回值示例

4.2 ToB 业务单据上传接口

4.2.1 参数说明

4.2.2 参数示例

4.2.3 返回值说明

4.1.4 返回值示例

4.3 ToB 采购单据上传

4.3.1 参数说明

4.3.2 参数示例

4.3.3 返回值说明

4.1.4 返回值示例

4.4 ToC 进行中销售单上传（对账用）接口

4.4.1 参数说明

4.4.2 参数示例

4.4.3 返回值说明

4.4.4 返回值示例

4.5 ToC 金额调整单上传（对账用）接口

4.5.1 参数说明

4.5.2 参数示例

4.5.3 返回值说明

4.5.4 返回值示例

4.6 POS传送对账平台的借贷支付方式

4.6.1 参数说明

4.6.2 参数示例

4.6.3 返回值说明

4.6.4 返回值示例

4.7 POS回传直营店到货状态

4.7.1 参数说明

4.7.2 请求参数示例

4.7.3 返回值说明

4.7.4 返回值示例

Reviews